Saltar al contenido principal

Traspaso de pago en lote

Esta API tiene como objetivo proporcionar una estructura estandarizada para la recepción de órdenes de traspaso de pagos; las órdenes pasarán por la realización de validaciones desde la etapa inicial de la creación del pedido hasta su aprobación final, donde se generará un archivo que contiene la conclusión sobre todas las órdenes contenidas en el pedido

Archivo de Envío​

Las órdenes de traspaso de pagos deben estar siempre contenidas en un archivo en formato .csv y estandarizado según el modelo disponibilizado. Este es el archivo que se enviará a la api de conciliación de crédito, se validará, procesará y solo entonces se generará el archivo de retorno.

Archivo de Retorno​

Es el archivo que se disponibilizará al socio al final de todo el procesamiento de un archivo de envío válido; contendrá todas las órdenes de traspaso de pagos que fueron aprobadas y rechazadas.

Upload del Archivo de Envío​

Para realizar el upload del archivo de envío es necesario, primeramente, la generación de un link prefirmado temporal de S3 (AWS) que sirve para hacer el upload de cualquier archivo a la plataforma de BTG Empresas.

// ejemplo de respuesta:
{
  "upload_url": "https://btg-file-uploads.s3.amazonaws.com/user_28771ABC/8bce6cfc-dcd4-473b-9fae-60ef3f60ec11?AWSAccessKeyId=JAIAIR3IFH6UCHKS&SB\\u0026Expires=1447353431\\u0026Signature=abK2ncbdlAIl2hk2921AKHQ%",
  "file_url": "https://s3-sa-east-1.amazonaws.com/btg-file-uploads/8bce6cfc-dcd4-473b-9fae-60ef3f60ec11"
}

El campo upload_url informa la dirección de la ruta que deberá utilizarse para efectuar el upload del archivo, mientras que el campo file_url informa la dirección del archivo que deberá utilizarse para la generación del pedido en la API de Conciliación de Crédito.

Después del upload del archivo, este quedará disponible en nuestra plataforma por hasta 3 días corridos, hasta que sea vinculado a una operación. Si se alcanza el plazo de expiración del archivo y el vínculo no se ha realizado, será necesario generar un nuevo link de upload y enviar el archivo nuevamente.

Crear Pedido​

En esta etapa de creación del pedido de Conciliación de Crédito es donde, de hecho, se inicializará la validación y el procesamiento del archivo, posibilitando posteriormente, ya sea vía solicitud REST, ya sea vía Webhook, la consulta del estado de ese pedido.

  • Crear Pedido de Conciliación de Crédito
// ejemplo de respuesta:
{
    "id": "0524b1ed-6a78-4f00-8394-543ffcd188f0",
    "status": "QUEUED"
}

Callback de estado del pedido​

Es una ruta que debe ser disponibilizada por el socio para recibir información referente al avance de un pedido y también la recepción del archivo de retorno.

// ejemplo de solicitud:
{
    "id": "bb9d844c-8041-464c-b160-471d437231d6",
    "status": "QUEUED",
    "conciliatedFileS3Url": ""
}

Consultar estado del pedido​

Alternativa al uso del webhook para la consulta del estado del pedido.

  • Consultar estado del pedido ref:get_v1-credit-conciliation-agreementid-creditconciliationorderid
// ejemplo de respuesta:
{
    "id": "bb9d844c-8041-464c-b160-471d437231d6",
    "status": "QUEUED",
    "conciliatedFileS3Url": ""
}

Recursos Disponibles​

Los recursos de la API de Traspaso de pago en lote están disponibles en el API Reference.

📘 API Reference

Traspaso de pago en lote